Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modify tma guide #1040

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Modify tma guide #1040

wants to merge 2 commits into from

Conversation

ihsraham
Copy link
Collaborator

@ihsraham ihsraham commented Jan 13, 2025

Motivation and Context

This update ensures the guide is blockchain-agnostic, making it more versatile for developers working with various blockchains. The changes improve usability by providing a generic example (Ethereum) and clarifying how to configure Web3Auth for any blockchain. This effort aligns with broader inclusivity goals for Web3Auth documentation.

Jira Link: DEVREL-1138

Description

  • Made the guide blockchain-agnostic by generalizing TON-specific details.
  • Updated chainConfig and privateKeyProvider to showcase Ethereum as a general example.
  • Removed dependencies tied specifically to TON.
  • Added a note to reference the "connect blockchain" guide for specific configurations.
  • Retained Telegram-specific elements crucial for mini-app setups.

How has this been tested?

  • Verified changes in a local development environment with mocked Telegram data.
  • Tested Ethereum configuration with Web3Auth's Single Factor Authentication.
  • Ensured compatibility with backend server setup as described in Part 1 of the guide.
  • Confirmed formatting and functionality align with documentation standards.

Screenshots (if appropriate):

N/A

Types of changes

  • Documentation update (non-breaking change to improve user experience)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project. (run lint)
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes. (Not applicable for documentation updates)
  • All new and existing tests passed.
  • My code requires a db migration. (Not applicable)

Copy link

vercel bot commented Jan 13, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
web3auth-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 13, 2025 2:56am

Copy link
Member

@shahbaz17 shahbaz17 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants